Skip to content

feat: Set up NGF integration to N1 Console #902

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 25 commits into
base: main
Choose a base branch
from
Open

feat: Set up NGF integration to N1 Console #902

wants to merge 25 commits into from

Conversation

mjang
Copy link
Contributor

@mjang mjang commented Jul 29, 2025

Extensively revised (14 Aug, midday), after extensive discussions with @bjee19 , @sylwang , and @sjberman

Proposed changes

Set up NGF integration into N1 Console.

  • This is similar to https://docs.nginx.com/nginx-one/k8s/add-nic/
    • But since NIC != NGF, I've changed labels / titles as appropriate
    • I've included some of the same steps to set up a data plane key, create a k8s secret, verify a connection, and for troubleshooting (I'm guessing the troubleshooting section, if applicable, will be different)
  • Many of the steps are the same with https://docs.nginx.com/nginx-gateway-fabric/install/helm/
    • I've added an include for one process, I've copy/pasted content with an include for a second process
  • I've included temporary references <!-- in comments --> to the UI and steps that we're using in that process

The primary build page is here: https://frontdoor-test-docs.nginx.com/previews/docs/902/nginx-one/k8s/add-ngf/

I think there's work to be done w/r/t data plane keys. We have a bunch of different ways to create them

  • There's an alert for when a data plane key is within 30 days of expiration
  • This may be best as a separate issue

This might close issue 660.
Closes #ISSUE

Checklist

Before merging a pull request, run through this checklist and mark each as complete.

  • I have read the contributing guidelines
  • I have signed the F5 Contributor License Agreement (CLA)
  • I have rebased my branch onto main
  • I have ensured my PR is targeting the main branch and pulling from my branch from my own fork
  • I have ensured that the commit messages adhere to Conventional Commits
  • I have ensured that documentation content adheres to the style guide
  • If the change involves potentially sensitive changes1, I have assessed the possible impact
  • If applicable, I have added tests that prove my fix is effective or that my feature works
  • I have ensured that existing tests pass after adding my changes
  • If applicable, I have updated README.md

Footnotes

  1. Potentially sensitive changes include anything involving code, personally identify information (PII), live URLs or significant amounts of new or revised documentation. Please refer to our style guide for guidance about placeholder content.

@github-actions github-actions bot added documentation Improvements or additions to documentation product/ngf Issues related to NGINX Gateway Fabric product/nginx-one Issues related to NGINX One Console labels Jul 29, 2025
Copy link

Deploy Preview will be available once build job completes!

Name Link
😎 Deploy Preview https://frontdoor-test-docs.nginx.com/previews/docs/902/

@mjang mjang changed the title DRAFt feat: Set up NGF integration to N1 Console DRAFT feat: Set up NGF integration to N1 Console Jul 29, 2025
@mjang mjang self-assigned this Jul 29, 2025
@mjang mjang changed the title DRAFT feat: Set up NGF integration to N1 Console Working draft: Set up NGF integration to N1 Console Jul 29, 2025
@mjang
Copy link
Contributor Author

mjang commented Jul 29, 2025

cc @sylwang @bjee19

@mjang mjang marked this pull request as ready for review August 6, 2025 14:09
@mjang mjang requested a review from a team as a code owner August 6, 2025 14:09
@mjang mjang changed the title Working draft: Set up NGF integration to N1 Console Set up NGF integration to N1 Console Aug 6, 2025
@mjang mjang changed the title Set up NGF integration to N1 Console feat: Set up NGF integration to N1 Console Aug 6, 2025
@sylwang
Copy link
Contributor

sylwang commented Aug 11, 2025

In NIC, the doc provided both the Helm and Manifests options for deploying. We'd want to do the same for NGF, and also include an option to deploy NGF using Manifests, as shown in the Figma design.
https://www.figma.com/design/Y0wCtVRjEa08HNfocSDVUb/GA---NGINX-One-SaaS-Console?node-id=8028-37869&t=HQ1wwsiaEMrrHdw9-0

@mjang mjang requested a review from bjee19 August 13, 2025 20:44
mjang and others added 4 commits August 14, 2025 06:34
Co-authored-by: bjee19 <139261241+bjee19@users.noreply.github.com>
Co-authored-by: Alan Dooley <a.dooley@f5.com>
@mjang
Copy link
Contributor Author

mjang commented Aug 14, 2025

In NIC, the doc provided both the Helm and Manifests options for deploying. We'd want to do the same for NGF, and also include an option to deploy NGF using Manifests, as shown in the Figma design. https://www.figma.com/design/Y0wCtVRjEa08HNfocSDVUb/GA---NGINX-One-SaaS-Console?node-id=8028-37869&t=HQ1wwsiaEMrrHdw9-0

Now that I've re-reviewed the Figma, I need to come up with a new file, probably add-ngf-manifests.md

@shaun-nx shaun-nx requested review from shaun-nx and removed request for n-pandey-f5 August 18, 2025 13:57
@shaun-nx
Copy link
Contributor

shaun-nx commented Aug 18, 2025

@mjang I noticed this PR has two separate pages for Helm and Manifest configurations.
The NGINX Ingress Controller documentation has settings for Helm and Manifest in the same page separated by tabs

Screen Shot 2025-08-18 at 14 56 11 PM

Is there a reason we are not following the same approach for this documentation?

@mjang
Copy link
Contributor Author

mjang commented Aug 18, 2025

@mjang I noticed this PR has two separate pages for Helm and Manifest configurations. The NGINX Ingress Controller documentation has settings for Helm and Manifest in the same page separated by tabs

Screen Shot 2025-08-18 at 14 56 11 PM Is there a reason we are not following the same approach for this documentation?

NGF integration has different options for NGINX OSS and NGINX Plus. That would have required "tabs within tabs" which don't seem to work with our build.

I need to go back and evaluate these docs for consistency. Maybe we should set up two separate pages for NIC integration.

@shaun-nx
Copy link
Contributor

@mjang thanks for clearing that up and for making the new issue. Lets go ahead with these docs for the release and we can refine them going forward. Great work!

Copy link
Contributor

@bjee19 bjee19 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

lgtm after remaining comments from Saylor are resolved.

### Provision an NGINX data plane

If you have not already done so, review [Deploy a Gateway for data plane instances]({{< ref "/ngf/install/deploy-data-plane.md" >}}).

### Verify the Deployment
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Since the Data plane guide you just linked checks for the deployment to be running, I don't think we need the Verify the Deployment section.

@@ -109,6 +109,10 @@ kubectl apply -f https://raw.githubusercontent.com/nginx/nginx-gateway-fabric/v{

{{</tabs>}}

### Provision an NGINX data plane

If you have not already done so, review [Deploy a Gateway for data plane instances]({{< ref "/ngf/install/deploy-data-plane.md" >}}).
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm assuming they wouldn't have done this, so maybe the preface to the sentence isn't necessary. Instead something like "To deploy the NGINX data plane to connect to the NGINX One Console, follow this guide".

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation product/ngf Issues related to NGINX Gateway Fabric product/nginx-one Issues related to NGINX One Console
Projects
None yet
Development

Successfully merging this pull request may close these issues.

8 participants